home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / man / lib.fmt / tcl / Tcl_Backslash.man < prev    next >
Encoding:
Text File  |  1989-11-27  |  2.1 KB  |  69 lines
  1.  
  2.  
  3.  
  4. Tcl_Backslash     Tcl Command Language Library      Tcl_Backslash
  5.  
  6.  
  7.  
  8. _________________________________________________________________
  9.  
  10. NNAAMMEE
  11.      Tcl_Backslash - parse a backslash sequence
  12.  
  13. SSYYNNOOPPSSIISS
  14.      ##iinncclluuddee <<ttccll..hh>>
  15.  
  16.      char
  17.      TTccll__BBaacckkssllaasshh(_s_r_c, _c_o_u_n_t_P_t_r)
  18.  
  19. AARRGGUUMMEENNTTSS
  20.      char      *_s_r_c           (in)      Pointer   to   a   string
  21.                                         starting      with      a
  22.                                         backslash.
  23.  
  24.      int       *_c_o_u_n_t_P_t_r      (out)     If _c_o_u_n_t_P_t_r  isn't  NULL,
  25.                                         *_c_o_u_n_t_P_t_r  gets filled in
  26.                                         with number of characters
  27.                                         in      the     backslash
  28.                                         sequence,  including  the
  29.                                         backslash character.
  30.  
  31. _________________________________________________________________
  32.  
  33.  
  34. DDEESSCCRRIIPPTTIIOONN
  35.      This is a utility procedure used by several of the Tcl  com-
  36.      mands.   It parses a backslash sequence and returns the sin-
  37.      gle character corresponding to the sequence.   TTccll__BBaacckkssllaasshh
  38.      modifies  *_c_o_u_n_t_P_t_r  to  contain the number of characters in
  39.      the backslash sequence.  If _s_r_c doesn't point to a backslash
  40.      sequence  understood  by  Tcl,  then Tcl_Backslash returns a
  41.      backslash as its result and *_c_o_u_n_t_P_t_r gets set to 1 (in this
  42.      case  the  backslash  character  should  not get any special
  43.      treatment).
  44.  
  45.      See the Tcl  manual  entry  for  information  on  the  valid
  46.      backslash  sequences.  All of the sequences described in the
  47.      Tcl manual  entry  are  supported  by  TTccll__BBaacckkssllaasshh  except  |
  48.      backslash-newline, which is not understood.
  49.  
  50.  
  51. KKEEYYWWOORRDDSS
  52.      backslash, parse
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65. Sprite v.1.0       Printed:  November 26, 1989                  1
  66.  
  67.  
  68.  
  69.